Instalacja

Poniższa instrukcja jest sugestią, jakie elementy i w jaki należy zainstalować i skonfigurować, aby móc tworzyć dokumentację korzystając z pełnego frameworka Docusaurus. Jeżeli preferujesz inne narzędzia, nic nie stoi na przeszkodzie, abyś z nich korzystał. Instrukcja omawia tylko środowisko Microsoft Windows.

Power Shell

Uruchom PowerShell z uprawnieniami Administratora

Git

winget install --id Git.Git -e --source winget

nodeJS

NodeJS to framework w którym wykonuje się kod Docusaurus. O ile nie poprawiasz prostych błędów w istniejących stronach dokumentacji to środowisko jest niezbędne podczas jej tworzenia. Pozwala lokalnie wyświetlać strony i sprawdza błędy logiczne.

winget install Schniz.fnm

warning

Zamknij i otwórz ponownie terminal PowerShell, aby poleceniem fnm było dostępne.

fnm env --use-on-cd | Out-String | Invoke-Expression

fnm use --install-if-missing 20

Microsoft Studio Code

Jest to edytor posiadający pełne wsparcie do tworzenia aplikacji w środowisku NodeJS. Pozwala na łatwą obsługę całego projektu.

winget install -e --id Microsoft.VisualStudioCode

Github Desktop

Jest to nakładka na git, która integruje się również z usługą GitHub i znacznie upraszcza pracę.

Pobierz i zainstaluj program.